+ <<<<<<< HEAD
+ [[http://melpa.org/packages/which-key-badge.svg]]
+ * which-key
+ =======
* which-key
[[http://melpa.org/#/which-key][http://melpa.org/packages/which-key-badge.svg]]
+ >>>>>>> master
** Introduction
-This is a rewrite of [[https://github.com/kai2nenobu/guide-key][guide-key-mode]] for emacs. The intention is to provide the
+=which-key= is a minor mode for Emacs that displays the keybindings following your currently
+entered incomplete command (a prefix) in a popup. For example, after enabling the minor mode
+if you enter =C-x= and wait for the default of 1 second the minibuffer will expand with all of
+the available keybindings that follow =C-x= (or as many as space allows given your settings).
+This includes prefixes like =C-x 8= which are shown in a different face. Screenshots of what
+the popup will look like are included below. =which-key= started as a rewrite of
+[[https://github.com/kai2nenobu/guide-key][guide-key-mode]], but the feature sets have diverged
+to a certain extent.
+
+With respect to =guide-key=, the intention is to provide the
following features:
1. A different polling mechanism to make it lighter on resources than guide-key
2. An improved display of keys with more keys being shown by default and a nicer